Add instrgen directory for source level instrumentation #3068

pdelewski · 2022-12-06T13:37:15Z

This PR adds new directory for source instrumentation according to discussions

open-telemetry/opentelemetry-go-instrumentation#3
#2834

MrAlias

Please update the owners file with the @open-telemetry/go-approvers, you @pdelewski, and me the owners of this directory.

pdelewski · 2022-12-07T08:02:54Z

@MrAlias Seems that my user does not have write access rights to this repo

MrAlias · 2022-12-08T00:30:56Z

@MrAlias Seems that my user does not have write access rights to this repo

@Aneurysm9 is this an issue you've seen in the collector contrib?

MrAlias

Please add an instrgen/go.mod to identify the new directory as a go module.

CHANGELOG.md

instrgen/README.md

MrAlias · 2022-12-08T18:39:27Z

@MrAlias Seems that my user does not have write access rights to this repo

@Aneurysm9 is this an issue you've seen in the collector contrib?

@pdelewski it sounds like these types of errors are ignored in the collector contrib. It will not be a blocker to merging as it will correctly identify the owner of the new package.

pdelewski · 2022-12-08T20:47:50Z

@MrAlias I updated Readme.md according to your suggestions. Please check it and approve if everything is ok. I plan to open a PR with instrgen implementation ASAP

MrAlias · 2022-12-09T00:56:09Z

This is still needed.

Please add an instrgen/go.mod to identify the new directory as a go module.

Be sure to run the dependabot generation script after it is added.

MrAlias

Looks good outside of adding a go.mod file.

CHANGELOG.md

linux-foundation-easycla · 2022-12-09T09:19:15Z

The committers listed above are authorized under a signed CLA.

✅ login: pdelewski / name: Przemyslaw Delewski (0b2d2c0)

pdelewski · 2022-12-09T10:39:36Z

Looks good outside of adding a go.mod file.

This now is failing as there are no go files to analyze. Should not go.mod be added together with implementation?

MrAlias · 2022-12-09T16:54:40Z

Looks good outside of adding a go.mod file.

This now is failing as there are no go files to analyze. Should not go.mod be added together with implementation?

Adding a doc.go file will solve this. E.g.

// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/*
Package instrgen provides a code generation utility that instruments existing
source code with OpenTelemetry.
*/
package instrgen // import "go.opentelemetry.io/contrib/instrgen"

pdelewski · 2022-12-09T17:22:48Z

@MrAlias Seems that I cannot merge it

MrAlias · 2022-12-09T17:45:49Z

@MrAlias Seems that I cannot merge it

Right. That is something maintainers of this project will do.

First, the tests need to succeed and another approver from another company needs to approve this: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/CONTRIBUTING.md#pull-requests

pdelewski · 2022-12-10T11:54:09Z

@MrAlias Seems that I cannot merge it

Right. That is something maintainers of this project will do.

First, the tests need to succeed and another approver from another company needs to approve this: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/CONTRIBUTING.md#pull-requests

@jmacd @MadVikingGod Could you look at this PR?

pdelewski · 2022-12-13T17:55:42Z

@MadVikingGod Could you merge it? as I don't have permissions yet

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

MadVikingGod · 2022-12-13T17:59:23Z

@pdelewski Even after this is merged you won't have merge permissions. That is only permitted to the maintainers group.

pdelewski · 2022-12-13T18:07:25Z

@pdelewski Even after this is merged you won't have merge permissions. That is only permitted to the maintainers group.

@MadVikingGod Yes, I know but approver should have them, right?

### Added - Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068, #3108) - Add an experimental `OTEL_METRICS_PRODUCERS` environment variable to `go.opentelemetry.io/contrib/autoexport` to be set metrics producers. (#5281) - `prometheus` and `none` are supported values. You can specify multiple producers separated by a comma. - Add `WithFallbackMetricProducer` option that adds a fallback if the `OTEL_METRICS_PRODUCERS` is not set or empty. - The `go.opentelemetry.io/contrib/processors/baggage/baggagetrace` module. This module provides a Baggage Span Processor. (#5404) - Add gRPC trace `Filter` for stats handler to `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc`. (#5196) - Add a repository Code Ownership Policy. (#5555) - The `go.opentelemetry.io/contrib/bridges/otellogrus` module. This module provides an OpenTelemetry logging bridge for `github.com/sirupsen/logrus`. (#5355) - The `WithVersion` option function in `go.opentelemetry.io/contrib/bridges/otelslog`. This option function is used as a replacement of `WithInstrumentationScope` to specify the logged package version. (#5588) - The `WithSchemaURL` option function in `go.opentelemetry.io/contrib/bridges/otelslog`. This option function is used as a replacement of `WithInstrumentationScope` to specify the semantic convention schema URL for the logged records. (#5588) - Add support for Cloud Run jobs in `go.opentelemetry.io/contrib/detectors/gcp`. (#5559) ### Changed - The gRPC trace `Filter` for interceptor is renamed to `InterceptorFilter`. (#5196) - The gRPC trace filter functions `Any`, `All`, `None`, `Not`, `MethodName`, `MethodPrefix`, `FullMethodName`, `ServiceName`, `ServicePrefix` and `HealthCheck` for interceptor are moved to `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters/interceptor`. With this change, the filters in `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc` are now working for stats handler. (#5196) - `NewLogger` now accepts a `name` `string` as the first argument. This parameter is used as a replacement of `WithInstrumentationScope` to specify the name of the logger backing the underlying `Handler`. (#5588) - `NewHandler` now accepts a `name` `string` as the first argument. This parameter is used as a replacement of `WithInstrumentationScope` to specify the name of the logger backing the returned `Handler`. (#5588) - Upgrade all dependencies of `go.opentelemetry.io/otel/semconv/v1.24.0` to `go.opentelemetry.io/otel/semconv/v1.25.0`. (#5605) ### Removed - The `WithInstrumentationScope` option function in `go.opentelemetry.io/contrib/bridges/otelslog` is removed. Use the `name` parameter added to `NewHandler` and `NewLogger` as well as `WithVersion` and `WithSchema` as replacements. (#5588) ### Deprecated - The `InterceptorFilter` type in `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc` is deprecated. (#5196)

### Added - Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (open-telemetry#3068, open-telemetry#3108) - Add an experimental `OTEL_METRICS_PRODUCERS` environment variable to `go.opentelemetry.io/contrib/autoexport` to be set metrics producers. (open-telemetry#5281) - `prometheus` and `none` are supported values. You can specify multiple producers separated by a comma. - Add `WithFallbackMetricProducer` option that adds a fallback if the `OTEL_METRICS_PRODUCERS` is not set or empty. - The `go.opentelemetry.io/contrib/processors/baggage/baggagetrace` module. This module provides a Baggage Span Processor. (open-telemetry#5404) - Add gRPC trace `Filter` for stats handler to `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc`. (open-telemetry#5196) - Add a repository Code Ownership Policy. (open-telemetry#5555) - The `go.opentelemetry.io/contrib/bridges/otellogrus` module. This module provides an OpenTelemetry logging bridge for `github.com/sirupsen/logrus`. (open-telemetry#5355) - The `WithVersion` option function in `go.opentelemetry.io/contrib/bridges/otelslog`. This option function is used as a replacement of `WithInstrumentationScope` to specify the logged package version. (open-telemetry#5588) - The `WithSchemaURL` option function in `go.opentelemetry.io/contrib/bridges/otelslog`. This option function is used as a replacement of `WithInstrumentationScope` to specify the semantic convention schema URL for the logged records. (open-telemetry#5588) - Add support for Cloud Run jobs in `go.opentelemetry.io/contrib/detectors/gcp`. (open-telemetry#5559) ### Changed - The gRPC trace `Filter` for interceptor is renamed to `InterceptorFilter`. (open-telemetry#5196) - The gRPC trace filter functions `Any`, `All`, `None`, `Not`, `MethodName`, `MethodPrefix`, `FullMethodName`, `ServiceName`, `ServicePrefix` and `HealthCheck` for interceptor are moved to `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters/interceptor`. With this change, the filters in `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc` are now working for stats handler. (open-telemetry#5196) - `NewLogger` now accepts a `name` `string` as the first argument. This parameter is used as a replacement of `WithInstrumentationScope` to specify the name of the logger backing the underlying `Handler`. (open-telemetry#5588) - `NewHandler` now accepts a `name` `string` as the first argument. This parameter is used as a replacement of `WithInstrumentationScope` to specify the name of the logger backing the returned `Handler`. (open-telemetry#5588) - Upgrade all dependencies of `go.opentelemetry.io/otel/semconv/v1.24.0` to `go.opentelemetry.io/otel/semconv/v1.25.0`. (open-telemetry#5605) ### Removed - The `WithInstrumentationScope` option function in `go.opentelemetry.io/contrib/bridges/otelslog` is removed. Use the `name` parameter added to `NewHandler` and `NewLogger` as well as `WithVersion` and `WithSchema` as replacements. (open-telemetry#5588) ### Deprecated - The `InterceptorFilter` type in `go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc` is deprecated. (open-telemetry#5196)

pdelewski requested review from jmacd, MrAlias, Aneurysm9, evantorrie, XSAM, dashpole, MadVikingGod, pellared, hanyuancheung and dmathieu as code owners December 6, 2022 13:37

pdelewski force-pushed the introducing-instrgen branch from 8a628e7 to d1f5c50 Compare December 6, 2022 13:43

MrAlias reviewed Dec 7, 2022

View reviewed changes

MrAlias closed this Dec 8, 2022

MrAlias reopened this Dec 8, 2022

This comment was marked as resolved.

Sign in to view

MrAlias reviewed Dec 8, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

instrgen/README.md Outdated Show resolved Hide resolved

instrgen/README.md Outdated Show resolved Hide resolved

instrgen/README.md Outdated Show resolved Hide resolved

instrgen/README.md Outdated Show resolved Hide resolved

pdelewski force-pushed the introducing-instrgen branch 2 times, most recently from dc1b66a to b14e1c2 Compare December 8, 2022 20:40

MrAlias reviewed Dec 9, 2022

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

pdelewski force-pushed the introducing-instrgen branch 2 times, most recently from b11fdc6 to 0b2d2c0 Compare December 9, 2022 09:30

Add instrgen directory for source level instrumentation

64e0aaa

pdelewski force-pushed the introducing-instrgen branch from 0b2d2c0 to 64e0aaa Compare December 9, 2022 17:16

MrAlias approved these changes Dec 9, 2022

View reviewed changes

MadVikingGod approved these changes Dec 13, 2022

View reviewed changes

MadVikingGod and others added 2 commits December 13, 2022 11:58

Update CHANGELOG.md

fdcffe3

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

Merge branch 'main' into introducing-instrgen

87696a5

MadVikingGod merged commit 3e6928d into open-telemetry:main Dec 13, 2022

MrAlias mentioned this pull request Jan 27, 2023

Add instrgen package to dependabot configuration #3188

Merged

MrAlias mentioned this pull request Mar 21, 2023

Add instrgen implementation #3108

Merged

MrAlias mentioned this pull request Sep 12, 2023

Release v1.19.0/v0.44.0/v0.13.0 #4299

Merged

pellared mentioned this pull request Nov 10, 2023

Release v1.21.0/v0.46.0/v0.15.0/v0.1.0 #4546

Merged

MadVikingGod mentioned this pull request Jan 18, 2024

Release 1.22.0/0.47.0/0.16.0/0.2.0 #4827

Merged

MrAlias mentioned this pull request May 21, 2024

Release v1.27.0/v0.52.0/v0.21.0/v0.7.0/v0.2.0 #5628

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add instrgen directory for source level instrumentation #3068

Add instrgen directory for source level instrumentation #3068

pdelewski commented Dec 6, 2022

MrAlias left a comment

pdelewski commented Dec 7, 2022

MrAlias commented Dec 8, 2022 •

edited

This comment was marked as resolved.

MrAlias left a comment

MrAlias commented Dec 8, 2022

pdelewski commented Dec 8, 2022

MrAlias commented Dec 9, 2022

MrAlias left a comment

linux-foundation-easycla bot commented Dec 9, 2022 •

edited

pdelewski commented Dec 9, 2022

MrAlias commented Dec 9, 2022

pdelewski commented Dec 9, 2022

MrAlias commented Dec 9, 2022

pdelewski commented Dec 10, 2022

pdelewski commented Dec 13, 2022

MadVikingGod commented Dec 13, 2022

pdelewski commented Dec 13, 2022

Add instrgen directory for source level instrumentation #3068

Add instrgen directory for source level instrumentation #3068

Conversation

pdelewski commented Dec 6, 2022

MrAlias left a comment

Choose a reason for hiding this comment

pdelewski commented Dec 7, 2022

MrAlias commented Dec 8, 2022 • edited

This comment was marked as resolved.

MrAlias left a comment

Choose a reason for hiding this comment

MrAlias commented Dec 8, 2022

pdelewski commented Dec 8, 2022

MrAlias commented Dec 9, 2022

MrAlias left a comment

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Dec 9, 2022 • edited

pdelewski commented Dec 9, 2022

MrAlias commented Dec 9, 2022

pdelewski commented Dec 9, 2022

MrAlias commented Dec 9, 2022

pdelewski commented Dec 10, 2022

pdelewski commented Dec 13, 2022

MadVikingGod commented Dec 13, 2022

pdelewski commented Dec 13, 2022

MrAlias commented Dec 8, 2022 •

edited

linux-foundation-easycla bot commented Dec 9, 2022 •

edited